<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>glGetDebugMessageLog - OpenGL ES 3.2 Reference Pages</title>
    <link rel="stylesheet" type="text/css" href="opengl-man.css"/>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
    <script type="text/x-mathjax-config">
            MathJax.Hub.Config({
                MathML: {
                    extensions: ["content-mathml.js"]
                },
                tex2jax: {
                    inlineMath: [['$','$'], ['\\(','\\)']]
                }
            });
        </script>
    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
  </head>
  <body>
    <header/>
    <div class="refentry" id="glGetDebugMessageLog">
      <div class="titlepage"/>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>glGetDebugMessageLog — retrieve messages from the debug message log</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>C Specification</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">GLuint <strong class="fsfunc">glGetDebugMessageLog</strong>(</code>
              </td>
              <td>GLuint <var class="pdparam">count</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLsizei <var class="pdparam">bufSize</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLenum *<var class="pdparam">sources</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>Glenum *<var class="pdparam">types</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLuint *<var class="pdparam">ids</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLenum *<var class="pdparam">severities</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLsizei *<var class="pdparam">lengths</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLchar *<var class="pdparam">messageLog</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>count</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The number of debug messages to retrieve from the log.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>bufSize</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The size of the buffer whose address is given by <em class="parameter"><code>messageLog</code></em>.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>sources</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The address of an array of variables to receive the sources of the retrieved messages.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>types</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The address of an array of variables to receive the types of the retrieved messages.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>ids</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The address of an array of unsigned integers to receive the ids of the retrieved messages.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>severities</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The address of an array of variables to receive the severites of the retrieved messages.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>lengths</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The address of an array of variables to receive the lengths of the received messages.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>messageLog</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The address of an array of characters that will receive the messages.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p>
            <code class="function">glGetDebugMessageLog</code> retrieves messages from the debug message log. A maximum of
            <em class="parameter"><code>count</code></em> messages are retrieved from the log. If <em class="parameter"><code>sources</code></em>
            is not NULL then the source of each message is written into up to <em class="parameter"><code>count</code></em> elements
            of the array. If <em class="parameter"><code>types</code></em>
            is not NULL then the type of each message is written into up to <em class="parameter"><code>count</code></em> elements
            of the array. If <em class="parameter"><code>id</code></em>
            is not NULL then the identifier of each message is written into up to <em class="parameter"><code>count</code></em> elements
            of the array. If <em class="parameter"><code>severities</code></em>
            is not NULL then the severity of each message is written into up to <em class="parameter"><code>count</code></em> elements
            of the array. If <em class="parameter"><code>lengths</code></em>
            is not NULL then the length of each message is written into up to <em class="parameter"><code>count</code></em> elements
            of the array.
        </p>
        <p>
            <em class="parameter"><code>messageLog</code></em> specifies the address of a character array into which the debug messages
            will be written. Each message will be concatenated onto the array starting at the first element of <em class="parameter"><code>messageLog</code></em>.
            <em class="parameter"><code>bufSize</code></em> specifies the size of the array <em class="parameter"><code>messageLog</code></em>. If a message will not
            fit into the remaining space in <em class="parameter"><code>messageLog</code></em> then the function terminates and returns the number
            of messages written so far, which may be zero.
        </p>
        <p>
            If <code class="function">glGetDebugMessageLog</code> returns zero then no messages are present in the debug log, or there
            was not enough space in <em class="parameter"><code>messageLog</code></em> to retrieve the first message in the queue. If <em class="parameter"><code>messageLog</code></em>
            is NULL then no messages are written and the value of <em class="parameter"><code>bufSize</code></em> is ignored.
        </p>
      </div>
      <div class="refsect1" id="notes">
        <h2>Notes</h2>
        <p>
            Although debug messages may be enabled in a non-debug context, the quantity and detail of such messages may be substantially
            inferior to those in a debug context. In particular, a valid implementation of the debug message queue in a non-debug context
            may produce no messages at all.
        </p>
      </div>
      <div class="refsect1" id="errors">
        <h2>Errors</h2>
        <p>
            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>count</code></em> or <em class="parameter"><code>bufSize</code></em> is negative.
        </p>
      </div>
      <div class="refsect1" id="associatedgets">
        <h2>Associated Gets</h2>
        <p>
            <a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEBUG_LOGGED_MESSAGES</code>
        </p>
        <p>
            <a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEBUG_NEXT_LOGGED_MESSAGE_LENGTH</code>
        </p>
        <p>
            <a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_DEBUG_MESSAGE_LENGTH</code>
        </p>
        <p>
            <a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_DEBUG_LOGGED_MESSAGES</code>
        </p>
      </div>
      <div class="refsect1" id="versions">
        <h2>Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">
                 
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="4">
                <span class="bold"><strong>OpenGL ES API Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.1</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.2</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">
                  <code class="function">glGetDebugMessageLog</code>
                </td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p>
            <a class="citerefentry" href="glDebugMessageInsert.xhtml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageInsert</span></span></a>,
            <a class="citerefentry" href="glDebugMessageCallback.xhtml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageCallback</span></span></a>,
            <a class="citerefentry" href="glDebugMessageControl.xhtml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageControl</span></span></a>.
        </p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright <span class="trademark"/>© 2013-2015 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p>
      </div>
    </div>
    <footer/>
  </body>
</html>
